<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - $.js.String</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><a href="../symbols/%24.html">$</a></li>
	
	<li><a href="../symbols/%24.browser.html">$.browser</a></li>
	
	<li><a href="../symbols/%24.dom.html">$.dom</a></li>
	
	<li><a href="../symbols/%24.dom.DOMTokenList.html">$.dom.DOMTokenList</a></li>
	
	<li><a href="../symbols/%24.dom.Element.html">$.dom.Element</a></li>
	
	<li><a href="../symbols/%24.dom.HTMLElement.html">$.dom.HTMLElement</a></li>
	
	<li><a href="../symbols/%24.dom.KeyboardEvent.html">$.dom.KeyboardEvent</a></li>
	
	<li><a href="../symbols/%24.dom.KeyboardEventListener.html">$.dom.KeyboardEventListener</a></li>
	
	<li><a href="../symbols/%24.dom.keyCodes.html">$.dom.keyCodes</a></li>
	
	<li><a href="../symbols/%24.dom.keyCodes_fixes.html">$.dom.keyCodes_fixes</a></li>
	
	<li><a href="../symbols/%24.dom.keyCodes_Safari2.html">$.dom.keyCodes_Safari2</a></li>
	
	<li><a href="../symbols/%24.dom.keyNames.html">$.dom.keyNames</a></li>
	
	<li><a href="../symbols/%24.dom.Node.html">$.dom.Node</a></li>
	
	<li><a href="../symbols/%24.dom.NodeList.html">$.dom.NodeList</a></li>
	
	<li><a href="../symbols/%24.js.html">$.js</a></li>
	
	<li><a href="../symbols/%24.js.Array.html">$.js.Array</a></li>
	
	<li><a href="../symbols/%24.js.Object.html">$.js.Object</a></li>
	
	<li><a href="../symbols/%24.js.String.html">$.js.String</a></li>
	
	<li><a href="../symbols/%24.profiler.html">$.profiler</a></li>
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Namespace $.js.String
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
			
				Holds the methods used for manipulating strings. Some of them are 
already available in JavaScript 1.6, natively.
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/src_core-js.js.html">core-js.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class $.js.String.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/%24.js.String.html">$.js.String</a></b>
							</div>
							<div class="description">Holds the methods used for manipulating strings.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class $.js.String.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">$.js.String.<b><a href="../symbols/%24.js.String.html#.escapeRegexp">escapeRegexp</a></b>()
								</div>
								<div class="description">Escape special characters in regular expressions.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">$.js.String.<b><a href="../symbols/%24.js.String.html#.escapeXML">escapeXML</a></b>()
								</div>
								<div class="description">Convert significant characters into entities.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">$.js.String.<b><a href="../symbols/%24.js.String.html#.stripTags">stripTags</a></b>()
								</div>
								<div class="description">Strip tags from a string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">$.js.String.<b><a href="../symbols/%24.js.String.html#.trim">trim</a></b>()
								</div>
								<div class="description">Trim whitespace from the start and the end of the string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">$.js.String.<b><a href="../symbols/%24.js.String.html#.trimLeft">trimLeft</a></b>()
								</div>
								<div class="description">Trim whitespace from the start of the string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">$.js.String.<b><a href="../symbols/%24.js.String.html#.trimRight">trimRight</a></b>()
								</div>
								<div class="description">Trim whitespace from the end of the string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">$.js.String.<b><a href="../symbols/%24.js.String.html#.unescapeXML">unescapeXML</a></b>()
								</div>
								<div class="description">Decode significant characters from entities.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont">
						<b>$.js.String</b>
				</div>
				
				<div class="description">
					Holds the methods used for manipulating strings. Some of them are already 
available in JavaScript 1.6, natively.

<p>By default, the global <var>String.prototype</var> object is extended to 
contain all the methods in this namespace, if they do not exists already.  
Thus, native String methods are not overwritten.

<p>All of these methods use their <var>this</var> object. As such, you need 
to pass the correct <var>this</var> object.

<p>In the examples provided for each method we will assume that the strings 
defined already have the methods. Thus code like 
<code><var>string</var>.trim()</code> can be written directly.
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".escapeRegexp"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">$.js.String.</span><b>escapeRegexp</b>()
					
					</div>
					<div class="description">
						Escape special characters in regular expressions.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The string with the special characters escaped.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".escapeXML"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">$.js.String.</span><b>escapeXML</b>()
					
					</div>
					<div class="description">
						Convert significant characters into entities. Any XML/HTML code has 
significant characters, like angle brackets and quotes. This method 
converts them to HTML entities, such that the resulting string can be used 
in Web pages without any problems.

<p>The characters being encoded are:

<ul>
  <li>' &amp; ' to ' &amp;amp; '
  <li>' &lt; ' to ' &amp;lt; '
  <li>' &gt; ' to ' &amp;gt; '
  <li>' " ' to ' &amp;#34; '
  <li>" ' " to ' &amp;#39; '
</ul>
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The string with the special characters encoded.</dd>
							
							</dl>
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd><a href="../symbols/%24.js.String.html#.unescapeXML">$.js.String.unescapeXML</a></dd>
							
							</dl>
						

					<hr />
				
					<a name=".stripTags"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">$.js.String.</span><b>stripTags</b>()
					
					</div>
					<div class="description">
						Strip tags from a string.

<p>Optionally, you may provide the list of tags to be stripped from the 
string. Each argument is considered a tag name.

<p>If no argument is provided, then all the tags in the string are 
stripped.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The string with tags stripped.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".trim"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">$.js.String.</span><b>trim</b>()
					
					</div>
					<div class="description">
						Trim whitespace from the start and the end of the string.
						
						
					</div>
					
					
					
					<pre class="code"><code>var str = " \n test \n  ";
var str2 = str.trim();</code>
// Now <code>str2 = 'test'</code>.</pre>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The string without any whitespace at the beginning, nor 
at the end.</dd>
							
							</dl>
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd><a href="../symbols/%24.js.String.html#.trimLeft">$.js.String.trimLeft</a></dd>
							
								<dd><a href="../symbols/%24.js.String.html#.trimRight">$.js.String.trimRight</a></dd>
							
							</dl>
						

					<hr />
				
					<a name=".trimLeft"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">$.js.String.</span><b>trimLeft</b>()
					
					</div>
					<div class="description">
						Trim whitespace from the start of the string.
						
						
					</div>
					
					
					
					<pre class="code"><code>var str = " \n test \n  ";
var str2 = str.trimLeft();</code>
// Now <code>str2 = "test \n  "</code>.</pre>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The string without any whitespace at the beginning.</dd>
							
							</dl>
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd><a href="../symbols/%24.js.String.html#.trim">$.js.String.trim</a></dd>
							
								<dd><a href="../symbols/%24.js.String.html#.trimRight">$.js.String.trimRight</a></dd>
							
							</dl>
						

					<hr />
				
					<a name=".trimRight"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">$.js.String.</span><b>trimRight</b>()
					
					</div>
					<div class="description">
						Trim whitespace from the end of the string.
						
						
					</div>
					
					
					
					<pre class="code"><code>var str = " \n test \n  ";
var str2 = str.trimRight();</code>
// Now <code>str2 = " \n test"</code>.</pre>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The string without any whitespace at the end.</dd>
							
							</dl>
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd><a href="../symbols/%24.js.String.html#.trim">$.js.String.trim</a></dd>
							
								<dd><a href="../symbols/%24.js.String.html#.trimLeft">$.js.String.trimLeft</a></dd>
							
							</dl>
						

					<hr />
				
					<a name=".unescapeXML"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">$.js.String.</span><b>unescapeXML</b>()
					
					</div>
					<div class="description">
						Decode significant characters from entities. This is the reverse method of 
<a href="../symbols/%24.js.String.html#.escapeXML">$.js.String.escapeXML</a>.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The string with the special characters decoded.</dd>
							
							</dl>
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd><a href="../symbols/%24.js.String.html#.escapeXML">$.js.String.escapeXML</a></dd>
							
							</dl>
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Mon May 11 2009 19:36:23 GMT+0300 (EEST)
		</div>
	</body>
</html>
